// -*- mode:c++ -*-

// Copyright (c) 2015 RISC-V Foundation
// Copyright (c) 2016 The University of Virginia
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met: redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer;
// redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution;
// neither the name of the copyright holders nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: Robert Scheffel

// Basic instruction class declaration template.
def template Basic32Declare {{
namespace Rv32
{

//
// Static instruction class for "%(mnemonic)s".
//
class %(class_name)s : public %(base_class)s
{
  public:
    /// Constructor.
    %(class_name)s(MachInst machInst);
    Fault execute(ExecContext *, Trace::InstRecord *) const override;
    using %(base_class)s::generateDisassembly;
};

} // namespace Rv32
}};

// Basic instruction class constructor template.
def template Basic32Constructor {{
Rv32::%(class_name)s::%(class_name)s(MachInst machInst)
    : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
{
    %(constructor)s;
}
}};


// Basic instruction class execute method template.
def template Basic32Execute {{
Fault
Rv32::%(class_name)s::execute(ExecContext *xc,
    Trace::InstRecord *traceData) const
{
    Fault fault = NoFault;

    %(op_decl)s;
    %(op_rd)s;
    if (fault == NoFault) {
        %(code)s;
        if (fault == NoFault) {
            %(op_wb)s;
        }
    }
    return fault;
}
}};

// Basic decode template.
def template Basic32Decode {{
    return new Rv32::%(class_name)s(machInst);
}};

// The most basic instruction format...
def format Basic32Op(code, *flags) {{
    iop = InstObjParams(name, Name, 'RiscvStaticInst', code, flags)
    header_output = Basic32Declare.subst(iop)
    decoder_output = Basic32Constructor.subst(iop)
    decode_block = Basic32Decode.subst(iop)
    exec_output = Basic32Execute.subst(iop)
}};
